Vcenter NamespaceManagement Supervisors Networks Management Network

Vcenter NamespaceManagement Supervisors Networks Management Network
Vcenter NamespaceManagement Supervisors Networks Management Network

Vcenter NamespaceManagement Supervisors Networks Management Network schema represents configuration for a network used to manage the Supervisor control plane. vCenter and, if used, NSX Manager and/or external Load Balancers, etc. should be reachable on this network.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "network": "string",
    "backing": {
        "backing": "string",
        "network": "string",
        "network_segment": {
            "networks": [
                "string"
            ]
        }
    },
    "services": {
        "dns": {
            "servers": [
                "string"
            ],
            "search_domains": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        }
    },
    "ip_management": {
        "dhcp_enabled": false,
        "gateway_address": "string",
        "ip_assignments": [
            {
                "assignee": "string",
                "ranges": [
                    {
                        "address": "string",
                        "count": 0
                    }
                ]
            }
        ]
    },
    "floating_ip_address": "string",
    "proxy": {
        "proxy_settings_source": "string",
        "https_proxy_config": "string",
        "http_proxy_config": "string",
        "no_proxy_config": [
            "string"
        ],
        "tls_root_ca_bundle": "string"
    }
}
string
network
Optional

Vcenter NamespaceManagement Supervisors Networks Management Network.network is a unique identifier for this network which can be referenced later for updates or queries.

This property was added in vSphere API 8.0.0.1.

If unset, an ID will be generated.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network.

backing
Required

Vcenter NamespaceManagement Supervisors Networks Management Network.backing specifies the network backing to use as the uplink to the management network.

This property was added in vSphere API 8.0.0.1.

services
Optional

Vcenter NamespaceManagement Supervisors Networks Management Network.services specifies which network services are configured on this network. These network services are expected to be accessible via the associated distributed virtual port group or distributed virtual switch.

This property was added in vSphere API 8.0.0.1.

If unset, network services may be automatically configured. If you want to disable any configuration of network services, explicitly set this schema to empty.

ip_management
Optional

Vcenter NamespaceManagement Supervisors Networks Management Network.ip_management describes how IP addressing is configured on this network.

This property was added in vSphere API 8.0.0.1.

If unset, this network becomes a DHCP network. Your DHCP server must support client identifiers to successfully enable a Supervisor.

string
floating_ip_address
Optional

Vcenter NamespaceManagement Supervisors Networks Management Network.floating_IP_address is an IP address that provides a stable endpoint to the control plane. This address if specified must be an unused statically allocated IP address on the management network.

This property was added in vSphere API 8.0.0.1.

If missing or null and the management network is a static network, this address should be allocated in a static IP configuration which occurs when Vcenter NamespaceManagement Networks IPManagement.dhcp_enabled is set to false. If missing or null and the management network is a DHCP network, The Supervisor will attempt to use the DHCP server to allocate this address. You should ensure the DHCP server is configured to persist IP addresses indefinitely using client identifiers if this configuration is used.

proxy
Optional

Proxy configuration will be applied to the Supervisor. The proxy should be reachable from the management network and will be used for image pulling and container traffic exiting out of the Supervisor.

This property was added in vSphere API 8.0.0.1.

If missing or null the settings will be inherited from the vCenter settings if available.